/*
 * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2005 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2007-2015 Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2008      Sun Microsystems, Inc.  All rights reserved.
 * Copyright (c) 2010-2012 Los Alamos National Security, LLC.
 *                         All rights reserved.
 * Copyright (c) 2019      Triad National Security, LLC. All rights
 *                         reserved.
 *
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#include "opal_config.h"

#include <errno.h>
#ifdef HAVE_FCNTL_H
#    include <fcntl.h>
#endif /* HAVE_FCNTL_H */
#ifdef HAVE_SYS_MMAN_H
#    include <sys/mman.h>
#endif /* HAVE_SYS_MMAN_H */
#ifdef HAVE_UNISTD_H
#    include <unistd.h>
#endif /* HAVE_UNISTD_H */
#ifdef HAVE_SYS_TYPES_H
#    include <sys/types.h>
#endif /* HAVE_SYS_TYPES_H */
#ifdef HAVE_SYS_IPC_H
#    include <sys/ipc.h>
#endif /* HAVE_SYS_IPC_H */
#if HAVE_SYS_SHM_H
#    include <sys/shm.h>
#endif /* HAVE_SYS_SHM_H */
#if HAVE_SYS_STAT_H
#    include <sys/stat.h>
#endif /* HAVE_SYS_STAT_H */
#include <string.h>
#ifdef HAVE_NETDB_H
#    include <netdb.h>
#endif /* HAVE_NETDB_H */

#include "opal/constants.h"
#include "opal/mca/shmem/base/base.h"
#include "opal/mca/shmem/shmem.h"
#include "opal/runtime/opal.h"
#include "opal/util/output.h"
#include "opal/util/path.h"
#include "opal/util/show_help.h"
#include "opal_stdint.h"

#include "shmem_sysv.h"

/* for tons of debug output: -mca shmem_base_verbose 70 */

/* ////////////////////////////////////////////////////////////////////////// */
/* local functions */
static int module_init(void);

static int segment_create(opal_shmem_ds_t *ds_buf, const char *file_name, size_t size);

static int ds_copy(const opal_shmem_ds_t *from, opal_shmem_ds_t *to);

static void *segment_attach(opal_shmem_ds_t *ds_buf);

static int segment_detach(opal_shmem_ds_t *ds_buf);

static int segment_unlink(opal_shmem_ds_t *ds_buf);

static int module_finalize(void);

/* sysv shmem module */
opal_shmem_sysv_module_t opal_shmem_sysv_module = {.super = {.module_init = module_init,
                                                             .segment_create = segment_create,
                                                             .ds_copy = ds_copy,
                                                             .segment_attach = segment_attach,
                                                             .segment_detach = segment_detach,
                                                             .unlink = segment_unlink,
                                                             .module_finalize = module_finalize}};

/* ////////////////////////////////////////////////////////////////////////// */
/* private utility functions */
/* ////////////////////////////////////////////////////////////////////////// */

/* ////////////////////////////////////////////////////////////////////////// */
/**
 * completely resets the contents of *ds_buf
 */
static inline void shmem_ds_reset(opal_shmem_ds_t *ds_buf)
{
    /* don't print ds_buf info here, as we may be printing garbage. */
    OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                         "%s: %s: shmem_ds_resetting\n",
                         mca_shmem_sysv_component.super.base_version.mca_type_name,
                         mca_shmem_sysv_component.super.base_version.mca_component_name));

    ds_buf->seg_cpid = 0;
    OPAL_SHMEM_DS_RESET_FLAGS(ds_buf);
    ds_buf->seg_id = OPAL_SHMEM_DS_ID_INVALID;
    ds_buf->seg_size = 0;
    memset(ds_buf->seg_name, '\0', OPAL_PATH_MAX);
    ds_buf->seg_base_addr = (unsigned char *) -1;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int module_init(void)
{
    /* nothing to do */
    return OPAL_SUCCESS;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int module_finalize(void)
{
    /* nothing to do */
    return OPAL_SUCCESS;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int ds_copy(const opal_shmem_ds_t *from, opal_shmem_ds_t *to)
{
    memcpy(to, from, sizeof(opal_shmem_ds_t));

    OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                         "%s: %s: ds_copy complete "
                         "from: (id: %d, size: %lu, "
                         "name: %s flags: 0x%02x) "
                         "to: (id: %d, size: %lu, "
                         "name: %s flags: 0x%02x)\n",
                         mca_shmem_sysv_component.super.base_version.mca_type_name,
                         mca_shmem_sysv_component.super.base_version.mca_component_name,
                         from->seg_id, (unsigned long) from->seg_size, from->seg_name, from->flags,
                         to->seg_id, (unsigned long) to->seg_size, to->seg_name, to->flags));

    return OPAL_SUCCESS;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int segment_create(opal_shmem_ds_t *ds_buf, const char *file_name, size_t size)
{
    int rc = OPAL_SUCCESS;
    pid_t my_pid = getpid();
    void *segment = MAP_FAILED;

    /* init the contents of opal_shmem_ds_t */
    shmem_ds_reset(ds_buf);

    /* for sysv shared memory we don't have to worry about the backing store
     * being located on a network file system... so no check is needed here.
     */

    /* create a new shared memory segment and save the shmid. */
    if (-1 == (ds_buf->seg_id = shmget(IPC_PRIVATE, size, IPC_CREAT | IPC_EXCL | S_IRWXU))) {
        int err = errno;
        const char *hn;
        hn = opal_gethostname();
        opal_show_help("help-opal-shmem-sysv.txt", "sys call fail", 1, hn, "shmget(2)", "",
                       strerror(err), err);
        rc = OPAL_ERROR;
        goto out;
    }
    /* attach to the sement */
    else if ((void *) -1 == (segment = shmat(ds_buf->seg_id, NULL, 0))) {
        int err = errno;
        const char *hn;
        hn = opal_gethostname();
        opal_show_help("help-opal-shmem-sysv.txt", "sys call fail", 1, hn, "shmat(2)", "",
                       strerror(err), err);
        shmctl(ds_buf->seg_id, IPC_RMID, NULL);
        rc = OPAL_ERROR;
        goto out;
    }
    /* mark the segment for destruction - if we are here, then the run-time
     * component selection test detected adequate support for this type of
     * thing.
     */
    else if (0 != shmctl(ds_buf->seg_id, IPC_RMID, NULL)) {
        int err = errno;
        const char *hn;
        hn = opal_gethostname();
        opal_show_help("help-opal-shmem-sysv.txt", "sys call fail", 1, hn, "shmctl(2)", "",
                       strerror(err), err);
        rc = OPAL_ERROR;
        goto out;
    }
    /* all is well */
    else {

        /* -- initialize the contents of opal_shmem_ds_t -- */
        ds_buf->seg_cpid = my_pid;
        ds_buf->seg_size = size;
        ds_buf->seg_base_addr = (unsigned char *) segment;

        /* notice that we are not setting ds_buf->name here. sysv doesn't use
         * it, so don't worry about it - shmem_ds_reset took care of
         * initialization, so we aren't passing garbage around.
         */

        /* set "valid" bit because setment creation was successful */
        OPAL_SHMEM_DS_SET_VALID(ds_buf);

        OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                             "%s: %s: create successful "
                             "(id: %d, size: %lu, name: %s)\n",
                             mca_shmem_sysv_component.super.base_version.mca_type_name,
                             mca_shmem_sysv_component.super.base_version.mca_component_name,
                             ds_buf->seg_id, (unsigned long) ds_buf->seg_size, ds_buf->seg_name));
    }

out:
    /* an error occured, so invalidate the shmem object and release any
     * allocated resources.
     */
    if (OPAL_SUCCESS != rc) {
        /* best effort to delete the segment. */
        if ((void *) -1 != segment) {
            shmdt((char *) segment);
        }
        shmctl(ds_buf->seg_id, IPC_RMID, NULL);

        /* always invalidate in this error path */
        shmem_ds_reset(ds_buf);
    }
    return rc;
}

/* ////////////////////////////////////////////////////////////////////////// */
/**
 * segment_attach can only be called after a successful call to segment_create
 */
static void *segment_attach(opal_shmem_ds_t *ds_buf)
{
    pid_t my_pid = getpid();

    if (my_pid != ds_buf->seg_cpid) {
        if ((void *) -1 == (ds_buf->seg_base_addr = shmat(ds_buf->seg_id, NULL, 0))) {
            int err = errno;
            const char *hn;
            hn = opal_gethostname();
            opal_show_help("help-opal-shmem-sysv.txt", "sys call fail", 1, hn, "shmat(2)", "",
                           strerror(err), err);
            shmctl(ds_buf->seg_id, IPC_RMID, NULL);
            return NULL;
        }
    }
    /* else i was the segment creator.  nothing to do here because all the hard
     * work was done in segment_create :-).
     */

    OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                         "%s: %s: attach successful "
                         "(id: %d, size: %lu, name: %s)\n",
                         mca_shmem_sysv_component.super.base_version.mca_type_name,
                         mca_shmem_sysv_component.super.base_version.mca_component_name,
                         ds_buf->seg_id, (unsigned long) ds_buf->seg_size, ds_buf->seg_name));

    /* update returned base pointer with an offset that hides our stuff */
    return ds_buf->seg_base_addr;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int segment_detach(opal_shmem_ds_t *ds_buf)
{
    int rc = OPAL_SUCCESS;

    OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                         "%s: %s: detaching "
                         "(id: %d, size: %lu, name: %s)\n",
                         mca_shmem_sysv_component.super.base_version.mca_type_name,
                         mca_shmem_sysv_component.super.base_version.mca_component_name,
                         ds_buf->seg_id, (unsigned long) ds_buf->seg_size, ds_buf->seg_name));

    if (0 != shmdt((char *) ds_buf->seg_base_addr)) {
        int err = errno;
        const char *hn;
        hn = opal_gethostname();
        opal_show_help("help-opal-shmem-sysv.txt", "sys call fail", 1, hn, "shmdt(2)", "",
                       strerror(err), err);
        rc = OPAL_ERROR;
    }

    /* reset the contents of the opal_shmem_ds_t associated with this
     * shared memory segment.
     */
    shmem_ds_reset(ds_buf);
    return rc;
}

/* ////////////////////////////////////////////////////////////////////////// */
static int segment_unlink(opal_shmem_ds_t *ds_buf)
{
    /* not much unlink work needed for sysv */

    OPAL_OUTPUT_VERBOSE((70, opal_shmem_base_framework.framework_output,
                         "%s: %s: unlinking "
                         "(id: %d, size: %lu, name: %s)\n",
                         mca_shmem_sysv_component.super.base_version.mca_type_name,
                         mca_shmem_sysv_component.super.base_version.mca_component_name,
                         ds_buf->seg_id, (unsigned long) ds_buf->seg_size, ds_buf->seg_name));

    /* don't completely reset the opal_shmem_ds_t.  in particular, only reset
     * the id and flip the invalid bit.  size and name values will remain valid
     * across unlinks. other information stored in flags will remain untouched.
     */
    ds_buf->seg_id = OPAL_SHMEM_DS_ID_INVALID;
    /* note: this is only chaning the valid bit to 0. */
    OPAL_SHMEM_DS_INVALIDATE(ds_buf);
    return OPAL_SUCCESS;
}
